<html>
	<head>
		<!-- Update title -->
		<title>Building Cinder Documentation</title>

		<!-- keywords used for searching -->
		<meta name="keywords" content="guide, docs, documentation">
		<meta name="viewport" content="width=device-width, initial-scale=1">


		<!-- reference to cinder classes -->
   		<!-- <ci seealso dox="[CLASS NAME GOES HERE]" label="[NAME OF LINK]"></ci> -->

   		<!-- master stylesheet - these links will be replaced when compiled -->
		<link rel="stylesheet" href="../../_assets/css/foundation.css">
		<link rel="stylesheet" href="../../_assets/css/prism.css">
		<link rel="stylesheet" href="../../_assets/css/style.css">
		<link href='http://fonts.googleapis.com/css?family=Open+Sans:400,300,600,700' rel='stylesheet' type='text/css'>

		<!-- Place additional stylsheet links here, which will be copied over when compiled (optional) -->

	</head>

	<body id="guide-contents" >

		<!-- //////////////////// CONTENT STARTS HERE //////////////////// -->

		<h1>Building Cinder Docs</h1>

		<p>The bundled Cinder source files includes documentation that you can view locally. You can find the <a href="https://libcinder.org/docs">online version here</a>. If you are cloning the Cinder GitHub repo, the docs will need to be generated in your cloned local repo. This is a 2-step process.</p>

		<section>
			<h2>Step 1: Doxygen Export</h2>
			<p>Cinder uses <a href="www.doxygen.org">Doxygen</a> in part to generate documentation from the cinder_docs source files. You can generate the Doxygen output and tag file using Doxywizard. The Cinder latest release uses Doxywizard 1.8.10. You can <a href="http://www.stack.nl/~dimitri/doxygen/download.html#srcbin" target="_blank">download Doxywizard here</a>.</p>

			<ul>
			<li>Launch Doxywizard</li>
			<li>Use the File | Open... menu item to open <strong>docs/doxygen/Doxyfile</strong>.</li>
			<li>Select the "Run" tab</li>
			<li>Click the "Run doxygen" button</li>
			</ul>

			<img class="shadow center rounded" src="images/doxygen.png">

			<p>This step builds out a directory of xml files and a <strong>cinder.tag</strong> file.</p>
		</section>

		<section>
			<h2>Step 2: Docs HTML File Generation</h2>

			<p>This next step generates the documentation from newly generated Doxygen output. It requires that you have python 2.7.x to run it.</p>
			<ul>
			<li>Open up your command line of choice</li>
			<li><code>cd docs</code></li>
			<li><code>python generateDocs.py</code></li>
			</ul>

			<img class="shadow center" src="images/terminal.png">

			<p>This process generates HTML files in the <code>Cinder/docs/html</code> directory. If the python file throws an error that results in incomplete docs, you can <a href="https://github.com/cinder/Cinder/issues/" taget="_blank">file a GitHub issue here</a>.</p>

		</section>

		<section>
			<h2>Step 3: Preview Docs Locally</h2>

			<p>You can use Python's SimpleHTTPServer to view the files:</p>
			<ul>
			<li>Open up your command line of choice</li>
			<li><code>cd html</code></li>
			<li><code>python -m SimpleHTTPServer 8000</code></li>
			<li>Open <a href="http://localhost:8000">http://localhost:8000</a></li>
			</ul>
		</section>

		<!-- //////////////////// END CONTENT //////////////////// -->

		<!-- Scripts -->
		<script src="../../_assets/js/prism.js" type="text/javascript"></script>
		<!-- Place additional scripts here (optional) -->
		<!-- <script type="text/javascript"></script> -->

	</body>
</html>
